package com.example.apidocserver.domain.document.event;

import com.example.apidocserver.application.dto.UserDocInfoDto;
import com.example.apidocserver.domain.document.entity.ApiInfo;
import com.example.apidocserver.domain.user.entity.DocUsrHis;
import com.example.apidocserver.interfaces.vo.ApiInfoAllVo;
import com.example.apidocserver.interfaces.vo.DocumentVo;

import java.util.List;

/**
 * 接口领域驱动
 *
 * @author xyqlg
 */
public interface ApiInfoDomainEvent {
    /**
     * 查询接口数据消息
     *
     * @param apiId 接口id
     * @return 接口对象信息
     */
    ApiInfo queryById(Integer apiId);

    /**
     * 设置当前接口信息，并设置参数说明和接口示例
     *
     * @param documentVo     文档返回信息对象
     * @param docUsrHis 用户信息
     */
    void setApiInfoAllByUser(DocumentVo documentVo, DocUsrHis docUsrHis);

    /**
     * 查询api信息，并设置参数说明和接口示例
     *
     * @param apiId     apiId
     * @param docUsrHis 用户权限信息
     * @return 接口文档信息
     */
    ApiInfoAllVo getApiInfoAll(Integer apiId, DocUsrHis docUsrHis);

    /**
     * 新增或修改接口信息
     *
     * @param apiInfoIn 接口信息
     * @return 接口信息
     */
    ApiInfo upsertApiInfo(ApiInfo apiInfoIn);

    /**
     * 根据接口名称或者接口路由查询接口信息
     *
     * @param apiInfo 查询信息
     * @param docId   文档id
     * @return 接口信息集合
     */
    List<ApiInfo> findApiLike(ApiInfo apiInfo, Integer docId);

    /**
     * 查询工作空间下所有接口信息
     *
     * @param spaceId 接口id
     * @return 接口信息集合
     */
    List<ApiInfo> findAllBySpaceId(Integer spaceId);

    /**
     * 批量插入或查询
     *
     * @param apiInfoList 接口信息
     */
    void insertOrFindBatch(List<ApiInfo> apiInfoList);
}
